//******************************************************************************
//
//                 Low Cost Vision
//
//******************************************************************************
// Project:        ueyeOpencv
// File:           UEyeOpenCVException.hpp
// Description:    Exception for UeyeOpenCV
// Author:         Wouter Langerak
// Notes:          For more functionalities use the SDK of UEye, the purpose of this project is to make it compatible with OpenCV Mat.
//
// License: newBSD 
//  
// Copyright © 2012, HU University of Applied Sciences Utrecht. 
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
// - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
// - Neither the name of the HU University of Applied Sciences Utrecht nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE HU UNIVERSITY OF APPLIED SCIENCES UTRECHT
// BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
// GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
// OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//******************************************************************************

#pragma once
#include <ueye.h>
#include <sstream>
#include <exception>
#include <iostream>

/**
 * Exception for UeyeOpenCV
 */
class UeyeOpenCVException : public std::exception {
private:
        HIDS cam;
        int exceptionId;
public:
        /**
         * Constructor
         * @param cam id of the camera (HIDS)
         * @param err
         */
        UeyeOpenCVException(HIDS cam, int err) {
                exceptionId = err;
        }
        /**
         * returns the error message.
         * @return
         */
        const char * what() const throw () {
                std::stringstream ss;
                ss << "UeyeOpenCVException on camera " << cam <<", with exit code:\t" << exceptionId;

                return ss.str().c_str();
        }
        /**
         * Returns the camera id(HIDS) of the camera on which the are occurred.
         * @return the camera id(HIDS) of the camera on which the are occurred.
         */
        HIDS getCam()
        {
                return cam;
        }
        /**
                * Returns the exception id of the camera on which the are occurred.
                * @return the exception id of the camera on which the are occurred.
                */
        int getExceptionId()
        {
                return exceptionId;
        }
};
